Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add usage of the Agoric VS Code extension #775

Closed
wants to merge 3 commits into from

Conversation

danBamikiya
Copy link

@cboydstun please take a look

cc: @dckc

@dckc dckc requested a review from ivanlei February 16, 2023 16:47
@dckc
Copy link
Member

dckc commented Feb 16, 2023

For context, note Agoric/agoric-sdk#5156 . I wonder why that's still open.

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like input from some other folks.

@@ -6,6 +6,16 @@ After installing the Agoric SDK, you can proceed to [starting a project](./start

## Quick Start

### Automated Install

If you're using VS Code as your code editor, install the official [Agoric Extension](https://marketplace.visualstudio.com/items?itemName=danbmky.agoric-vscode) to automate the Agoric SDK install process:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if "official" is how we should describe it. That might suggest that it's supported by the Agoric engineering team, and I'm not sure we're there yet.

In particular, Agoric/agoric-sdk#6419 seems to be outstanding and is out for a bounty rather than being in the engineering queue.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dckc thanks for the review. Agoric/agoric#5156 is already completed and should be closed I think (cc: @jeetraut).

also, Agoric/agoric-sdk#6419 has long been completed and the bounty has been paid too, so I guess it should be closed too (cc: @cboydstun).

I used the word "official" to describe it because there's already another extension on the VS Code marketplace (and registry) with the description "agoric sdk install" and it has some downloads already. So, to not confuse users on which to download, I thought "official" would better describe it.

Screenshot 2023-02-16 at 10 24 02 PM

and "official" also suggests that the extension is maintained, which I do, I published the version 1.0.7 of the Agoric Extension today to both the VS Code Registry and the Open VSX Registry, this recent version converts the extension into a "Workspace Extension" from a "UI Extension" allowing the extension to also be downloadable and run on both Gitpod and GitHub Codespaces platform, supporting more users! 🎉


Agoric Extension running on Gitpod:
Screenshot 2023-02-16 at 10 44 03 PM


Agoric Extension running on GitHub Codespaces:
Screenshot 2023-02-16 at 10 48 38 PM

Side Note:
Agoric Extension as seen on the Open VSX Registry that allows it to be downloaded on Gitpod:
image

we could go for another description though.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow! very nice work!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! 🥳

@arirubinstein
Copy link
Contributor

For this to be "official", we would need to own the extension and the Agoric namespace in the VSCode store, so in the mean time I'm ok with referring to it as a community resource.

@danBamikiya
Copy link
Author

@dckc I have removed the 'official' description as adviced by @arirubinstein

@dckc dckc mentioned this pull request Feb 22, 2023
@ivanlei
Copy link
Contributor

ivanlei commented Feb 22, 2023

While the extension is quite cool, these docs target an developer audience familiar working with node & installing dependencies. This extension is most helpful for a different audience.

I think for developers whose workflow includes project specific VS Code plugins, this is a nice solve, and can be found searching agoric on the VC code extension marketplace - https://marketplace.visualstudio.com/search?term=agoric&target=VSCode&category=All%20categories&sortBy=Relevance

@ivanlei ivanlei closed this Feb 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants